package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.ApplyToProgEmployAddDTO;
import org.jsola.hr.dto.ApplyToProgEmployUpdateDTO;
import org.jsola.hr.query.ApplyToProgEmployQuery;
import org.jsola.hr.vo.ApplyToProgEmployListVO;
import org.jsola.hr.vo.ApplyToProgEmployVO;

import java.util.List;

/**
 * @author zhr
 */
@Api(tags = "hr-方案适用设置聘用形式")
public interface IApplyToProgEmployControllerAPI {

    /**
     * 新增方案适用设置聘用形式
     * @param applyToProgEmployAddDTO 方案适用设置聘用形式新增实体
     * @return 方案适用设置聘用形式展示对象
     */
    @ApiOperation(value = "新增方案适用设置聘用形式")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "applyToProgEmployAddDTO", dataType = "ApplyToProgEmployAddDTO", value = "新增方案适用设置聘用形式", paramType = "body")
    })
    Result<ApplyToProgEmployVO> save(ApplyToProgEmployAddDTO applyToProgEmployAddDTO);


    /**
     * 修改方案适用设置聘用形式
     * @param applyToProgEmployUpdateDTO 方案适用设置聘用形式
     * @return 更新数量
     */
    @ApiOperation(value = "修改方案适用设置聘用形式")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "applyToProgEmployUpdateDTO", dataType = "ApplyToProgEmployUpdateDTO", value = "修改方案适用设置聘用形式", paramType = "body")
    })
    Result<Integer> update(ApplyToProgEmployUpdateDTO applyToProgEmployUpdateDTO);




    /**
     * 删除单个方案适用设置聘用形式，彻底删除
     * @param applyToProgEmployId 方案适用设置聘用形式id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个方案适用设置聘用形式，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "applyToProgEmployId", dataType = "String", value = "方案适用设置聘用形式id", paramType = "path")
    })
    Result<Integer> delete(String applyToProgEmployId);


    /**
     * 批量删除方案适用设置聘用形式，彻底删除
     * @param applyToProgEmployIds 方案适用设置聘用形式id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除方案适用设置聘用形式，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "applyToProgEmployIds", dataType = "String[]", value = "方案适用设置聘用形式id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(String[] applyToProgEmployIds);


    /**
     * 根据方案适用设置聘用形式id查询方案适用设置聘用形式详情
     * @param applyToProgEmployId 方案适用设置聘用形式id
     * @return 方案适用设置聘用形式详情
     */
    @ApiOperation(value="根据方案适用设置聘用形式id查询方案适用设置聘用形式详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "applyToProgEmployId", dataType = "String", value = "方案适用设置聘用形式id", paramType = "path")
    })
    Result<ApplyToProgEmployVO> findById(String applyToProgEmployId);


    /**
     * 查询方案适用设置聘用形式
     * @param applyToProgEmployQuery 方案适用设置聘用形式查询参数
     * @return page
     */
    @ApiOperation(value="查询方案适用设置聘用形式")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "applyToProgEmployQuery", dataType = "ApplyToProgEmployQuery", value = "方案适用设置聘用形式查询参数", paramType = "query")
    })
    Result<List<ApplyToProgEmployListVO>> listAll(ApplyToProgEmployQuery applyToProgEmployQuery);


     /**
     * 分页查询方案适用设置聘用形式
     * @param applyToProgEmployQuery 方案适用设置聘用形式查询参数
     * @return page
     */
    @ApiOperation(value="分页查询方案适用设置聘用形式")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "applyToProgEmployQuery", dataType = "ApplyToProgEmployQuery", value = "方案适用设置聘用形式查询参数", paramType = "query")
    })
    Result<Page<ApplyToProgEmployListVO>> page(ApplyToProgEmployQuery applyToProgEmployQuery);


}

